Skip to main content

Get All Shipments

GET /tms/shipments

Description​

This endpoint is used to retrieve all shipments. You can filter shipments using various query parameters like status, startDate, endDate, etc.

Parameters​

  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code.
  • pageNumber (integer, query, optional): The page number for pagination.
  • pageSize (integer, query, optional): The page size for pagination.
  • status (array[string], query, optional): The status of the shipments.
  • startDate (string, query, optional): The start date for filtering shipments.
  • endDate (string, query, optional): The end date for filtering shipments.
  • carrierId (array[string], query, optional): The carrier IDs.
  • carrierType (array[string], query, optional): The carrier types.
  • vehicleId (array[string], query, optional): The vehicle IDs.
  • driverUserId (array[string], query, optional): The driver user IDs.
  • searchValue (string, query, optional): The search value.
  • spaceId (string, query, optional): The space ID.

Responses​

200 OK​

  • Media type: Controls Accept header.
  • Description: Shipments found.
  • Example Value:
{
  "status": true,
  "statusCode": 0,
  "message": "string",
  "data": {},
  "errors": [
    {
      "message": "string",
      "descriptiveMessage": "string"
    }
  ]
}

400 Invalid Reference Supplied​

Description: Invalid reference supplied.

404 Resource Not Found​

Description: Resource not found.

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /tms/shipments \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!